Package com.getsensibill.rest.generated.v2.model

Types

AccessTokenRequestDto
Link copied to clipboard
data class AccessTokenRequestDto(grantType: String, redirectUri: String, refreshToken: String, code: String?)
AccessTokenResponseDto
Link copied to clipboard
data class AccessTokenResponseDto(tokenId: String?, accessToken: String?, refreshToken: String?, tokenType: String?, expiresIn: Int?, refreshExpiresIn: Int?)
AddOrRemoveDocumentsFromFolderDto
Link copied to clipboard
data class AddOrRemoveDocumentsFromFolderDto(documentIds: List<String>)
AlertDto
Link copied to clipboard
data class AlertDto(name: AlertDto.Name?, count: Int?, list: List<UserReceiptDto>?)
ApiInfoDto
Link copied to clipboard
data class ApiInfoDto(hostname: String?, version: String?, status: String?, environment: String?, name: String?, bootedAt: OffsetDateTime?, baseUrl: String?, endpoints: ApiInfoDtoEndpoints?)
ApiInfoDtoEndpoints
Link copied to clipboard
data class ApiInfoDtoEndpoints(authorizationGrant: String?, accessToken: String?, logout: String?, clientInfo: String?, invalidateAccessToken: String?, jwtAuthenticate: String?, usernameAvailability: String?, emailAvailability: String?, registerUser: String?, jwtRegister: String?, users: String?, userDetail: String?, deleteUser: String?, updateUser: String?, forgotpassword: String?, resetpassword: String?, exportDocuments: String?, listExports: String?, exportStatus: String?, lookupSupportedCurrencies: String?, lookupSupportedLocales: String?, merchantsList: String?, documentsList: String?, documentsPost: String?, documentsDelete: String?, documentsPatch: String?, documentsDetail: String?, listFolders: String?, createFolder: String?, deleteFolders: String?, updateFolder: String?, deleteFolder: String?, addDocumentsToFolder: String?, deleteDocumentsFromFolder: String?)
AuthorizationResponse
Link copied to clipboard
data class AuthorizationResponse(code: String?)
ClientInfoResponseDto
Link copied to clipboard
data class ClientInfoResponseDto(clientID: String?, name: String?, type: String?, status: String?, key: String?, redirectURI: String?, policies: List<ClientPoliciesDto>?, authenticationSettings: ClientInfoResponseDtoAuthenticationSettings?, notificationSettings: ClientInfoResponseDtoNotificationSettings?, providerIDs: ClientInfoResponseDtoProviderIDs?, accessTokenExpiry: OffsetDateTime?)
data class ClientInfoResponseDtoAuthenticationSettings(oauth: Boolean?, refreshTokenExpiryDays: Int?, accessTokenExpiryMinutes: Int?, setTempAccessSecret: Boolean?, disablePasswordStrengthCheck: Boolean?, maximumFailedLoginAttempts: Int?, jwt: Boolean?)
data class ClientInfoResponseDtoNotificationSettings(accountUpdates: Boolean?)
An object describing which notifications could be sent for this client.
ClientInfoResponseDtoProviderIDs
Link copied to clipboard
data class ClientInfoResponseDtoProviderIDs(gmail: String?, outlook: String?)
Identifiers for external integrations used by this client.
ClientPoliciesDto
Link copied to clipboard
data class ClientPoliciesDto(id: String?, webSDKOptions: ClientPoliciesDtoWebSDKOptions?, registrationEmails: List<String>?, registrationEmailPolicyMode: String?, receiptEmailDomainPolicyMode: String?, credentialTypePolicyMode: String?, featurePolicyMode: String?, features: List<String>?, allowedFeatures: ClientPoliciesDtoAllowedFeatures?, credentialTypes: List<String>?, receiptEmailDomains: List<String>?, receiptEmailDomainsAndAliases: List<ClientPoliciesDtoReceiptEmailDomainsAndAliasesInner>?, featureOptions: ClientPoliciesDtoFeatureOptions?)
ClientPoliciesDtoAllowedFeatures
Link copied to clipboard
data class ClientPoliciesDtoAllowedFeatures(clientCanDisableUser: Boolean?, clientCanRetrieveUserData: Boolean?, clientCanDestroyUsers: Boolean?, enhancedReceiptView: Boolean?, editing: Boolean?, userManagement: Boolean?, navigation: Boolean?, registration: Boolean?, noReceiptAccount: Boolean?, nonEmailUsernames: Boolean?, merchantLogo: Boolean?, merchantColor: Boolean?, menuViewAll: Boolean?, forgotPassword: Boolean?, feedback: Boolean?, enableExportEmails: Boolean?, emailNotifications: Boolean?, advertiseEmailForwarding: Boolean?)
ClientPoliciesDtoFeatureOptions
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptions(insights: ClientPoliciesDtoFeatureOptionsInsights?, achievements: ClientPoliciesDtoFeatureOptionsInsights?, outgoingEmail: ClientPoliciesDtoFeatureOptionsOutgoingEmail?, metrics: ClientPoliciesDtoFeatureOptionsMetrics?, camera: ClientPoliciesDtoFeatureOptionsCamera?, showNotificationCenter: Boolean?, enableOfflineSupport: Boolean?, filters: ClientPoliciesDtoFeatureOptionsFilters?, listingScreen: ClientPoliciesDtoFeatureOptionsListingScreen?, issueReporting: ClientPoliciesDtoFeatureOptionsIssueReporting?, showExpenseType: Boolean?, showTips: Boolean?, reminders: ClientPoliciesDtoFeatureOptionsReminders?, showCategories: Boolean?, showNotes: Boolean?, showTags: Boolean?, showFavorites: Boolean?, showFolders: Boolean?, exports: ClientPoliciesDtoFeatureOptionsExports?, showUserManagement: Boolean?, registration: ClientPoliciesDtoFeatureOptionsRegistration?, showEditing: Boolean?, showBarcodeDisplay: Boolean?, showNavigation: Boolean?, enableReceiptLinking: Boolean?, enableEnhancedReceiptView: Boolean?, receiptDisplayLevel: Int?, enableEmailNotifications: Boolean?, showForgotPassword: Boolean?, branding: ClientPoliciesDtoFeatureOptionsBranding?)
ClientPoliciesDtoFeatureOptionsBranding
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsBranding(emailPrimaryColor: String?, showPoweredByLogo: Boolean?, showMerchantLogos: Boolean?, showMerchantColors: Boolean?)
ClientPoliciesDtoFeatureOptionsCamera
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsCamera(frontendAutomaticCaptureTimeout: Int?, showLongReceiptCapture: Boolean?, frontendCameraCaptureDefault: String?, showAutomaticCapture: Boolean?)
ClientPoliciesDtoFeatureOptionsExports
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsExports(populateName: Boolean?, requireAuthentication: Boolean?, enableExportNotifications: Boolean?, showExports: Boolean?)
ClientPoliciesDtoFeatureOptionsFilters
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsFilters(showPaymentFilter: Boolean?, showDateFilter: Boolean?, showCurrencyFilter: Boolean?, showFilters: Boolean?)
ClientPoliciesDtoFeatureOptionsInsights
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsInsights(deactivationDate: String?, activationDate: String?)
data class ClientPoliciesDtoFeatureOptionsIssueReporting(showAdditionalFeedback: Boolean?, showIssueReporting: Boolean?)
data class ClientPoliciesDtoFeatureOptionsListingScreen(showWeeklyGrouping: Boolean?, showMonthlyGrouping: Boolean?)
ClientPoliciesDtoFeatureOptionsMetrics
Link copied to clipboard
data class ClientPoliciesDtoFeatureOptionsMetrics(siteID: String?, trackingURL: String?, enableMetrics: Boolean?)
data class ClientPoliciesDtoFeatureOptionsOutgoingEmail(frontendUrlBase: String?, emailViewPrefix: String?, senderAddress: String?)
data class ClientPoliciesDtoFeatureOptionsRegistration(receiptAccountEmail: ClientPoliciesDtoFeatureOptionsRegistration.ReceiptAccountEmail?, requireReceiptAccount: Boolean?, requireEmails: Boolean?, showRegistration: Boolean?)
data class ClientPoliciesDtoFeatureOptionsReminders(enableReturnReminders: Boolean?, enableWarrantyReminders: Boolean?, showReminders: Boolean?)
data class ClientPoliciesDtoReceiptEmailDomainsAndAliasesInner(id: String?, emailDomain: String?, aliases: List<String>?)
ClientPoliciesDtoWebSDKOptions
Link copied to clipboard
data class ClientPoliciesDtoWebSDKOptions(webDebug: Boolean?, webBaseUrl: String?, webSDKUrl: String?)
CommonRegistrationParameters
Link copied to clipboard
data class CommonRegistrationParameters(receiptAccountEmail: String?, firstName: String?, lastName: String?, defaultCurrency: String?, folders: List<CommonRegistrationParametersFoldersInner>?, createTestReceipts: Boolean?)
data class CommonRegistrationParametersFoldersInner(name: String?, color: String?, id: String?)
CountryCode
Link copied to clipboard
enum CountryCode : Enum<CountryCode>
2 character country code (lower case)Values: CA,US,UK,IE,ES,NL
CourierDto
Link copied to clipboard
data class CourierDto(name: String?, serviceLevel: String?)
Information about the courier being used.
CurrencyCodeEnum
Link copied to clipboard
enum CurrencyCodeEnum : Enum<CurrencyCodeEnum>
3 character ISO-4217 currency codeValues: USD,CAD,GBP,EUR,NZD,AUD,BRL,CLP,CNY,CZK,DKK,HKD,HUF,INR,IDR,ILS,JPY,MYR,MXN,NOK,PKR,PHP,PLN,RUB,SGD,ZAR,KRW,SEK,CHF,TWD,THB,TRY
DeliveryDto
Link copied to clipboard
data class DeliveryDto(addressLines: List<String>?, courier: CourierDto?, deliveryType: DeliveryTypesEnum?, expectedShipmentDate: LocalDate?, name: String?, telephoneNumber: String?, trackingNumber: String?)
Details about an expected delivery.
DeliveryTypesEnum
Link copied to clipboard
enum DeliveryTypesEnum : Enum<DeliveryTypesEnum>
Type of deliveryValues: PICKUP,DELIVERY,SHIPPING
DiscountTypesEnum
Link copied to clipboard
enum DiscountTypesEnum : Enum<DiscountTypesEnum>
May be set to describe how this discount was obtained.
DocumentAccountMetadataDto
Link copied to clipboard
data class DocumentAccountMetadataDto(account: String?, transactionId: String?)
DocumentCategoryListItemDto
Link copied to clipboard
data class DocumentCategoryListItemDto(code: String, name: String, icon: URI)
DocumentContentBarcodeDto
Link copied to clipboard
data class DocumentContentBarcodeDto(text: String?, type: String?)
Describes a barcode as read from a document.
DocumentContentCustomerDto
Link copied to clipboard
data class DocumentContentCustomerDto(customerId: String?, billingAddressLines: List<String>?, email: String?, name: String?, telephoneNumber: String?)
Information about the customer as presented on the document.
DocumentContentDto
Link copied to clipboard
data class DocumentContentDto(amountDue: DocumentTaxableAmountDto?, barcodes: List<DocumentContentBarcodeDto>?, countryCode: CountryCode?, currencyCode: CurrencyCodeEnum?, customer: DocumentContentCustomerDto?, discounts: List<DocumentDiscountDto>?, documentNumber: String?, dueDate: LocalDate?, documentDate: LocalDate?, documentTime: String?, fees: List<DocumentFeeDto>?, items: List<DocumentItemDto>?, languageCode: String?, merchant: DocumentMerchantDto?, savings: BigDecimal?, deliveries: List<DeliveryDto>?, loyaltyRewards: DocumentLoyaltyRewardsDto?, payments: List<DocumentPaymentDto>?, tipAmount: BigDecimal?, total: DocumentTaxableAmountDto?, totalBeforeTips: DocumentTaxableAmountDto?, totalBeforeDiscountsFeesTips: DocumentTaxableAmountDto?)
DocumentCreationResponseDto
Link copied to clipboard
data class DocumentCreationResponseDto(id: String)
DocumentCurrencyListItemDto
Link copied to clipboard
data class DocumentCurrencyListItemDto(name: String, code: String, symbol: String)
DocumentDeleteDto
Link copied to clipboard
data class DocumentDeleteDto(ids: List<String>)
DocumentDeleteResponseDto
Link copied to clipboard
data class DocumentDeleteResponseDto(ids: List<String>)
The list of document Ids which were deleted from the system
DocumentDiscountDto
Link copied to clipboard
data class DocumentDiscountDto(taxes: List<DocumentTaxDto>?, beforeTax: BigDecimal?, afterTax: BigDecimal?, description: String?, methodCode: String?, percent: BigDecimal?, type: DiscountTypesEnum?)
Contains info about one applied discount.
DocumentDiscountDtoAllOf
Link copied to clipboard
data class DocumentDiscountDtoAllOf(description: String?, methodCode: String?, percent: BigDecimal?, type: DiscountTypesEnum?, taxes: List<DocumentTaxDto>?)
DocumentDto
Link copied to clipboard
data class DocumentDto(id: String, arrivalDateTime: OffsetDateTime, lastUpdateDateTime: OffsetDateTime, documentType: DocumentTypeEnum, status: DocumentStatusTypeEnum, foreignId: String?, accountMetadata: DocumentAccountMetadataDto?, description: String?, content: DocumentContentDto?, source: DocumentSourceDto?, userMetadata: DocumentUserMetadataDto?)
DocumentFeeDto
Link copied to clipboard
data class DocumentFeeDto(taxes: List<DocumentTaxDto>?, beforeTax: BigDecimal?, afterTax: BigDecimal?, description: String?, type: FeeTypesEnum?)
Contains info about one applied fee.
DocumentFeeDtoAllOf
Link copied to clipboard
data class DocumentFeeDtoAllOf(description: String?, type: FeeTypesEnum?, taxes: List<DocumentTaxDto>?)
DocumentItemDto
Link copied to clipboard
data class DocumentItemDto(description: String?, brand: String?, buyLink: String?, discounts: List<DocumentDiscountDto>?, fees: List<DocumentFeeDto>?, imageUrl: String?, itemIds: List<String>?, listPrice: DocumentTaxableAmountDto?, loyaltyRewards: DocumentLoyaltyRewardsDto?, name: String?, price: DocumentTaxableAmountDto?, priceBeforeDiscountsFees: DocumentTaxableAmountDto?, properties: List<DocumentItemDtoPropertiesInner>?, serialNumbers: List<String>?, sku: String?, unitListPrice: DocumentTaxableAmountDto?, unitOfMeasure: String?, unitPrice: DocumentTaxableAmountDto?, unitQuantity: BigDecimal?)
DocumentItemDtoPropertiesInner
Link copied to clipboard
data class DocumentItemDtoPropertiesInner(name: String?, value: String?)
DocumentListItemContentDto
Link copied to clipboard
data class DocumentListItemContentDto(documentNumber: String?, currencyCode: CurrencyCodeEnum?, documentDate: LocalDate?, documentTime: String?, payments: List<DocumentPaymentDto>?, merchant: DocumentListMerchantDto?, total: DocumentTaxableAmountDto?, amountDue: DocumentTaxableAmountDto?)
DocumentListItemDto
Link copied to clipboard
data class DocumentListItemDto(id: String, arrivalDateTime: OffsetDateTime, lastUpdateDateTime: OffsetDateTime, documentType: DocumentTypeEnum, status: DocumentStatusTypeEnum, foreignId: String?, accountMetadata: DocumentAccountMetadataDto?, description: String?, content: DocumentListItemContentDto?, source: DocumentSourceDto?, userMetadata: DocumentUserMetadataDto?)
DocumentListMerchantDto
Link copied to clipboard
data class DocumentListMerchantDto(merchantName: String?, categoryCode: String?)
The merchant infomation on this document.
DocumentLocaleListItemDto
Link copied to clipboard
data class DocumentLocaleListItemDto(name: String, code: String)
DocumentLoyaltyRewardsDto
Link copied to clipboard
data class DocumentLoyaltyRewardsDto(accountNumber: String?, currentBalance: BigDecimal?, nextRewardLevel: BigDecimal?, pointsAwarded: BigDecimal?, programName: String?)
Describes loyalty rewards read from the receipt.
DocumentMerchantDto
Link copied to clipboard
data class DocumentMerchantDto(addressLines: List<String>?, merchantId: String?, merchantName: String?, email: String?, geoLocation: String?, storeName: String?, storeId: String?, telephone: String?, channel: OrderChannelTypesEnum?, categoryCode: String?, taxIdNumber: String?, url: String?)
DocumentOrderByEnum
Link copied to clipboard
enum DocumentOrderByEnum : Enum<DocumentOrderByEnum>
Values: ASC,DESC
DocumentPaymentDto
Link copied to clipboard
data class DocumentPaymentDto(afterTax: BigDecimal?, cashBack: BigDecimal?, changeAdjustment: BigDecimal?, changeDue: BigDecimal?, changeIssued: BigDecimal?, currencyCode: CurrencyCodeEnum?, maskedCardNumber: String?, type: TenderTypesEnum?)
data class DocumentsAddedOrRemovedFromFolderResponseDto(updated: Int)
DocumentSortByEnum
Link copied to clipboard
enum DocumentSortByEnum : Enum<DocumentSortByEnum>
Values: ARRIVAL_DATE_TIME,DOCUMENT_DATE,DOCUMENT_TIME
DocumentSourceDto
Link copied to clipboard
data class DocumentSourceDto(format: DocumentSourceFormatsEnum, url: String, imagePreview: String)
DocumentSourceFormatsEnum
Link copied to clipboard
enum DocumentSourceFormatsEnum : Enum<DocumentSourceFormatsEnum>
Values: PDF,IMAGE,RAW_TEXT,PDF_EMAIL,HTML_EMAIL,IMAGE_EMAIL,TEXT_EMAIL
DocumentsStatusResponseDto
Link copied to clipboard
data class DocumentsStatusResponseDto(documents: List<DocumentStatusListItemDto>, errors: List<DocumentStatusErrorItemDto>?)
Response schema for the documents/status endpoint
DocumentStatusErrorItemDto
Link copied to clipboard
data class DocumentStatusErrorItemDto(id: String, message: String)
Represents an error that can occur while polling for document processing status
DocumentStatusListItemDto
Link copied to clipboard
data class DocumentStatusListItemDto(id: String, arrivalDateTime: OffsetDateTime, documentType: DocumentTypeEnum, status: DocumentStatusTypeEnum, foreignId: String?, lastUpdateDateTime: OffsetDateTime?)
Schema for an entry in the documents/status endpoint response
DocumentStatusTypeEnum
Link copied to clipboard
enum DocumentStatusTypeEnum : Enum<DocumentStatusTypeEnum>
The status of the document involved or used for the operation.
DocumentTaxableAmountDto
Link copied to clipboard
data class DocumentTaxableAmountDto(taxes: List<DocumentTaxDto>?, beforeTax: BigDecimal?, afterTax: BigDecimal?)
DocumentTaxDto
Link copied to clipboard
data class DocumentTaxDto(amount: BigDecimal?, percent: BigDecimal?, type: String?)
DocumentTypeEnum
Link copied to clipboard
enum DocumentTypeEnum : Enum<DocumentTypeEnum>
The document type that is being posted.
DocumentUserMetadataDto
Link copied to clipboard
data class DocumentUserMetadataDto(expenseType: ExpenseTypeEnum?, folders: List<String>?, notes: String?, warrantyPeriod: DocumentUserMetadataPeriodDto?, returnPeriod: DocumentUserMetadataPeriodDto?)
DocumentUserMetadataPeriodDto
Link copied to clipboard
data class DocumentUserMetadataPeriodDto(unit: PeriodUnitEnum?, duration: Int?)
EditDocumentMerchantDto
Link copied to clipboard
data class EditDocumentMerchantDto(merchantName: String?, taxIdNumber: String?, categoryCode: String?)
EditDocumentRequestDto
Link copied to clipboard
data class EditDocumentRequestDto(description: String?, accountMetadata: NullableDocumentAccountMetadataDto?, content: EditDocumentRequestDtoContent?, userMetadata: EditDocumentUserMetadataDto?)
Object that contains the field that will be updated in a Document.
EditDocumentRequestDtoContent
Link copied to clipboard
data class EditDocumentRequestDtoContent(merchant: EditDocumentMerchantDto?, documentNumber: String?, dueDate: LocalDate?, documentDate: LocalDate?, documentTime: String?, amountDue: EditDocumentTaxableAmountDto?, tipAmount: BigDecimal?, totalBeforeDiscountsFeesTips: EditDocumentTaxableAmountDto?, total: EditDocumentTaxableAmountDto?, currencyCode: CurrencyCodeEnum?)
EditDocumentResponseDto
Link copied to clipboard
data class EditDocumentResponseDto(id: String)
Object with the Id of the updated Document
EditDocumentTaxableAmountDto
Link copied to clipboard
data class EditDocumentTaxableAmountDto(taxes: List<DocumentTaxDto>?, beforeTax: BigDecimal?, afterTax: BigDecimal?)
EditDocumentUserMetadataDto
Link copied to clipboard
data class EditDocumentUserMetadataDto(expenseType: String?, notes: String?, warrantyPeriod: EditDocumentUserMetadataPeriodDto?, returnPeriod: EditDocumentUserMetadataPeriodDto?)
EditDocumentUserMetadataPeriodDto
Link copied to clipboard
data class EditDocumentUserMetadataPeriodDto(unit: String?, duration: Int?)
EmailAvailabilityResponseDto
Link copied to clipboard
data class EmailAvailabilityResponseDto(available: Boolean?)
EmptyObjectResponseDto
Link copied to clipboard
data class EmptyObjectResponseDto(noProperties: String?)
An empty object.
ExpenseTypeEnum
Link copied to clipboard
enum ExpenseTypeEnum : Enum<ExpenseTypeEnum>
Expense type associated with the document.
ExportCreateDto
Link copied to clipboard
data class ExportCreateDto(outputFormats: List<String>, criteria: ListDocumentsCriteriaDto, locale: String?)
ExportCreateResponseDto
Link copied to clipboard
data class ExportCreateResponseDto(destructionTime: OffsetDateTime, createdAt: OffsetDateTime, criteria: ListDocumentsCriteriaDto, outputFormats: List<String>, documentsCount: BigDecimal, status: ExportResponseStatusEnum, id: String)
ExportItemStatusEnum
Link copied to clipboard
enum ExportItemStatusEnum : Enum<ExportItemStatusEnum>
The status of the export.
ExportResponseStatusEnum
Link copied to clipboard
enum ExportResponseStatusEnum : Enum<ExportResponseStatusEnum>
Values: QUEUED,NO_DOCUMENTS_FOUND
ExportsResponseDto
Link copied to clipboard
data class ExportsResponseDto(destructionTime: OffsetDateTime, createdAt: OffsetDateTime, updatedAt: OffsetDateTime, resultSize: Int, criteria: ListDocumentsCriteriaDto?, outputFormats: List<String>, documents: List<ExportsResponseDtoDocumentsInner>, status: ExportItemStatusEnum, id: String, completionTime: OffsetDateTime?, fileURL: String?, filesize: Int?)
ExportsResponseDtoDocumentsInner
Link copied to clipboard
data class ExportsResponseDtoDocumentsInner(id: String?)
FeeTypesEnum
Link copied to clipboard
enum FeeTypesEnum : Enum<FeeTypesEnum>
May be set to give more details on the type of fee.
FolderCreateRequestDto
Link copied to clipboard
data class FolderCreateRequestDto(name: String, color: String)
FolderCreationResponseDto
Link copied to clipboard
data class FolderCreationResponseDto(id: String)
FolderDeleteRequestDto
Link copied to clipboard
data class FolderDeleteRequestDto(deleteDocuments: Boolean?)
FolderListItemDto
Link copied to clipboard
data class FolderListItemDto(id: String, name: String, color: String, updatedAt: OffsetDateTime, createdAt: OffsetDateTime, count: Int, totals: List<FolderListItemTotalsDto>?)
FolderListItemTotalsDto
Link copied to clipboard
data class FolderListItemTotalsDto(amount: BigDecimal, count: Int, currencyCode: String, displayAmount: String)
FoldersDeleteRequestDto
Link copied to clipboard
data class FoldersDeleteRequestDto(folders: List<String>, deleteDocuments: Boolean?)
FolderUpdateRequestDto
Link copied to clipboard
data class FolderUpdateRequestDto(name: String?, color: String?)
GetDocumentErrorDto
Link copied to clipboard
data class GetDocumentErrorDto(errorDescription: String, code: String)
Describes the error related to the request if there was a failure
GetDocumentListResponseDto
Link copied to clipboard
data class GetDocumentListResponseDto(documents: List<DocumentListItemDto>, count: Int)
Structure of the response on the document list endpoint
GetDocumentResponseDto
Link copied to clipboard
data class GetDocumentResponseDto(document: DocumentDto, error: GetDocumentErrorDto?)
Structure of the response on the document details endpoint
GetFoldersListResponseDto
Link copied to clipboard
data class GetFoldersListResponseDto(folders: List<FolderListItemDto>)
GetLookupCategoryListResponseDto
Link copied to clipboard
data class GetLookupCategoryListResponseDto(documentCategories: List<DocumentCategoryListItemDto>?)
GetLookupCurrencyListResponseDto
Link copied to clipboard
data class GetLookupCurrencyListResponseDto(currencies: List<DocumentCurrencyListItemDto>)
GetLookupLocaleListResponseDto
Link copied to clipboard
data class GetLookupLocaleListResponseDto(locales: List<DocumentLocaleListItemDto>)
JwtAuthenticateRequestDto
Link copied to clipboard
data class JwtAuthenticateRequestDto(client: String)
JwtAuthenticateResponseDto
Link copied to clipboard
data class JwtAuthenticateResponseDto(tokenId: String?, accessToken: String?, expiresIn: Int?)
JwtUserRequestDto
Link copied to clipboard
data class JwtUserRequestDto(client: String, receiptAccountEmail: String?, firstName: String?, lastName: String?, defaultCurrency: String?, folders: List<CommonRegistrationParametersFoldersInner>?, createTestReceipts: Boolean?)
JwtUserRequestDtoProperties
Link copied to clipboard
data class JwtUserRequestDtoProperties(client: String)
ListDocumentsCriteriaDto
Link copied to clipboard
data class ListDocumentsCriteriaDto(accountMetadataAccount: List<String>?, accountMetadataAccountExists: Boolean?, accountMetadataTransactionId: List<String>?, accountMetadataTransactionIdExists: Boolean?, amountDue: List<BigDecimal>?, amountDueGte: BigDecimal?, amountDueLte: BigDecimal?, arrivalDateTimeGte: OffsetDateTime?, arrivalDateTimeLte: OffsetDateTime?, categoryCode: List<String>?, currencyCode: List<String>?, description: List<String>?, documentDate: List<LocalDate>?, documentDateGte: LocalDate?, documentDateLte: LocalDate?, documentNumber: List<String>?, documentTime: List<String>?, documentTimeGte: String?, documentTimeLte: String?, documentType: List<DocumentTypeEnum>?, foreignId: List<String>?, id: List<String>?, lastUpdateDateTimeGte: OffsetDateTime?, lastUpdateDateTimeLte: OffsetDateTime?, merchantName: List<String>?, merchantTaxIdNumber: List<String>?, paymentTender: List<TenderTypesEnum>?, total: List<BigDecimal>?, totalGte: BigDecimal?, totalLte: BigDecimal?, status: List<DocumentStatusTypeEnum>?, sourceFormat: List<DocumentSourceFormatsEnum>?)
The search criteria used to find the documents to be exported.
MerchantsDto
Link copied to clipboard
data class MerchantsDto(merchants: List<MerchantsDtoMerchantsInner>)
MerchantsDtoMerchantsInner
Link copied to clipboard
data class MerchantsDtoMerchantsInner(merchantID: String, name: String, documentCateogry: String?)
NullableDocumentAccountMetadataDto
Link copied to clipboard
data class NullableDocumentAccountMetadataDto(account: String?, transactionId: String?)
OrderChannelTypesEnum
Link copied to clipboard
enum OrderChannelTypesEnum : Enum<OrderChannelTypesEnum>
Indicates if the receipt came from a brick and mortar or online channel.
PeriodUnitEnum
Link copied to clipboard
enum PeriodUnitEnum : Enum<PeriodUnitEnum>
Available period units.
RegisterUserResponseDto
Link copied to clipboard
data class RegisterUserResponseDto(id: String?)
SimplifiedFolderDto
Link copied to clipboard
data class SimplifiedFolderDto(id: String?, name: String?, color: String?, updatedAt: OffsetDateTime?, createdAt: OffsetDateTime?)
TenderTypesEnum
Link copied to clipboard
enum TenderTypesEnum : Enum<TenderTypesEnum>
Values: AMEX,CASH,CHECK,COUPON,CREDIT,CREDIT_DEBIT,CUSTOMER_ACCOUNT,DEBIT,DINERS_CLUB,FLEET,GIFT_CARD,GIFT_CERTIFICATE,HOUSE_ACCOUNT,INTERAC,INTERNATIONAL_MAESTRO,LOYALTY,MASTER_CARD,PAYPAL,PREPAID,STORE_CARD,STORED_VALUE,TRAVELERS_CHECK,UK_MAESTRO,VISA_CREDIT,VISA_DEBIT,VISA,VOUCHER
UsernameAvailabilityResponseDto
Link copied to clipboard
data class UsernameAvailabilityResponseDto(available: Boolean?)
UserReceiptDto
Link copied to clipboard
data class UserReceiptDto(objectType: String?, receiptDate: OffsetDateTime?, listingSortDate: OffsetDateTime?, merchantName: String?, renderURL: String?, total: UserReceiptDtoTotal?, id: String?)
UserReceiptDtoTotal
Link copied to clipboard
data class UserReceiptDtoTotal(grand: BigDecimal?, currencyCode: String?)
UserRequestDto
Link copied to clipboard
data class UserRequestDto(receiptAccountEmail: String?, firstName: String?, lastName: String?, defaultCurrency: String?, folders: List<CommonRegistrationParametersFoldersInner>?, createTestReceipts: Boolean?, credentialType: String?, accessID: String?, accessSecret: String?, email: String?, password: String?)
UserRequestProperties
Link copied to clipboard
data class UserRequestProperties(credentialType: String?, accessID: String?, accessSecret: String?, email: String?, password: String?)
UserResponseDto
Link copied to clipboard
data class UserResponseDto(email: String?, receiptAccountEmail: String?, receiptCounts: UserResponseDtoReceiptCounts?, emailCounts: UserResponseDtoEmailCounts?, folders: List<SimplifiedFolderDto>?, notificationSettings: UserResponseDtoNotificationSettings?, locale: String?, status: String?, lastName: String?, firstName: String?, id: String?, accessID: String?, credentialType: String?, nickname: String?, alerts: List<AlertDto>?, pilotAccess: UserResponseDtoPilotAccess?, accessTokenExpiry: OffsetDateTime?, refreshTokenExpiry: OffsetDateTime?)
Get account info for current user
UserResponseDtoEmailCounts
Link copied to clipboard
data class UserResponseDtoEmailCounts(nonreceipt: Int?, receipt: Int?, total: Int?)
data class UserResponseDtoNotificationSettingsAccountUpdates(email: Boolean?)
data class UserResponseDtoNotificationSettingsOther(email: Boolean?)
data class UserResponseDtoNotificationSettingsReceipt(includeOriginal: Boolean?, email: Boolean?, push: Boolean?)
data class UserResponseDtoNotificationSettingsReceiptExport(email: Boolean?, push: Boolean?)
UserResponseDtoPilotAccess
Link copied to clipboard
data class UserResponseDtoPilotAccess(diagnostics: UserResponseDtoPilotAccessDiagnostics?)
UserResponseDtoPilotAccessDiagnostics
Link copied to clipboard
data class UserResponseDtoPilotAccessDiagnostics(enabled: Boolean?)
UserResponseDtoReceiptCounts
Link copied to clipboard
data class UserResponseDtoReceiptCounts(favorite: Int?, thisMonth: Int?, total: Int?)
UserUpdateDtoProperties
Link copied to clipboard
data class UserUpdateDtoProperties(status: String?, receiptAccountEmail: String?, firstName: String?, lastName: String?, defaultCurrency: String?, locale: String?)